API

Logistics APIs

GET logistics/assignment-registers

List of assignment registers

HTTP method GET
URI https://api.rambase.net/logistics/assignment-registers
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 530, version 9

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

AssignmentRegisterId Integer Assignment register identifier.
AvailableQuantity Decimal The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned. As an example, the available quantity is decreased when you assign a sales order item. Note that the remaining quantity in this example will not decrease before the goods is shipped.
ConfirmedDeliveryDate Date The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Location String Unique abbreviation/short name of the location.
OwnerDatabase String Abbreviation/code to identify the company.
OwnerItemId Integer Line number of the document item.
OwnerObjectId Integer Identifier of the document.
OwnerObjectType String Archive of the document.
OwnerType String Type of assignment register.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal The quantity from the owner item.
RemainingQuantity Decimal The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.
RequestedDeliveryDate Date The requested delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the requested delivery date field. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Status of assignment register.

Read more about filters and sorting on how to use sortable parameters

AssignmentRegisterId Integer Assignment register identifier
AvailableQuantity Decimal The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned. As an example, the available quantity is decreased when you assign a sales order item. Note that the remaining quantity in this example will not decrease before the goods is shipped.
ConfirmedDeliveryDate Date The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field.
CreatedAt Datetime Date and time of creation
Location String Unique abbreviation/short name of the location
OwnerDatabase String Abbreviation/code to identify the company
OwnerItemId Integer Line number of the document item
OwnerObjectId Integer Identifier of the document
OwnerObjectType String Archive of the document
OwnerType String Type of assignment register
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal The quantity from the owner item.
RemainingQuantity Decimal The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.
RequestedDeliveryDate Date The requested delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the requested delivery date field.
Status Integer Status of assignment register

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<AssignmentRegisters>
2
     <AssignmentRegister>
3
          <AssignmentRegisterId
AssignmentRegisterId

Assignment register identifier

>{Integer}</AssignmentRegisterId>
4
          <Status
Status

Status of assignment register

>{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <RemainingQuantity
RemainingQuantity

The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.

>{Decimal}</RemainingQuantity>
7
          <AvailableQuantity
AvailableQuantity

The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned. As an example, the available quantity is decreased when you assign a sales order item. Note that the remaining quantity in this example will not decrease before the goods is shipped.

>{Decimal}</AvailableQuantity>
8
          <OwnerType
OwnerType

Type of assignment register

Possible domain values can be found here

>{String}</OwnerType>
9
          <Owner>
10
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
11
               <RequestedDeliveryDate
RequestedDeliveryDate

The requested delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the requested delivery date field.

>{Date}</RequestedDeliveryDate>
12
               <ConfirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field.

>{Date}</ConfirmedDeliveryDate>
13
               <Quantity
Quantity

The quantity from the owner item.

>{Decimal}</Quantity>
14
               <Object>
15
                    <Database
Database

Database of the object

>{String}</Database>
16
                    <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
17
                    <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
18
                    <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
19
               </Object>
20
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
21
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
22
          </Owner>
23
          <Location
Location

The location of the assignment register. The location is either from the owner item, or from the initial demand.

>
24
               <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
25
          </Location>
26
          <Product
Product

The product of the assignemt register. The product is either from the owner item, or from the the requested demand.

>
27
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
28
               <Name
Name

Name of the product

>{String}</Name>
29
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
30
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
31
          </Product>
32
          <ExclusivelyForCustomer
ExclusivelyForCustomer

If customer is specified, this customer owns the goods in stock/the product that is being manufactured

>
33
               <Database
Database

Database of the object

>{String}</Database>
34
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
35
               <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
36
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
37
          </ExclusivelyForCustomer>
38
          <AssignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

>{String}</AssignmentRegisterLink>
39
     </AssignmentRegister>
40
     <Paging
Paging

Detailed paging information for this list.

>
41
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
42
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
43
          <Page
Page

Page index

>{Integer}</Page>
44
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
45
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
46
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
47
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
48
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
49
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
50
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
51
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
52
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
53
     </Paging>
54
</AssignmentRegisters>
1
{
2
     "assignmentRegisters": [
3
          {
4
               "assignmentRegisterId
AssignmentRegisterId

Assignment register identifier

": "{Integer}",
5
               "status
Status

Status of assignment register

": "{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "remainingQuantity
RemainingQuantity

The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.

": "{Decimal}",
8
               "availableQuantity
AvailableQuantity

The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned. As an example, the available quantity is decreased when you assign a sales order item. Note that the remaining quantity in this example will not decrease before the goods is shipped.

": "{Decimal}",
9
               "ownerType
OwnerType

Type of assignment register

Possible domain values can be found here

": "{String}",
10
               "owner": {
11
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
12
                    "requestedDeliveryDate
RequestedDeliveryDate

The requested delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the requested delivery date field.

": "{Date}",
13
                    "confirmedDeliveryDate
ConfirmedDeliveryDate

The confirmed delivery date retrieved from the owner item. Note that this field only will be valid if the owner item has the confirmed delivery date field.

": "{Date}",
14
                    "quantity
Quantity

The quantity from the owner item.

": "{Decimal}",
15
                    "object": {
16
                         "database
Database

Database of the object

": "{String}",
17
                         "objectId
ObjectId

Identifier of the object

": "{Integer}",
18
                         "objectType
ObjectType

Type of object

": "{String}",
19
                         "objectLink
ObjectLink

API reference to the object

": "{String}"
20
                    },
21
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
22
                    "itemLink
ItemLink

API reference to the item

": "{String}"
23
               },
24
               "location
Location

The location of the assignment register. The location is either from the owner item, or from the initial demand.

": {
25
                    "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
26
               },
27
               "product
Product

The product of the assignemt register. The product is either from the owner item, or from the the requested demand.

": {
28
                    "productId
ProductId

Product identifier

": "{Integer}",
29
                    "name
Name

Name of the product

": "{String}",
30
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
31
                    "productLink
ProductLink

Product reference

": "{String}"
32
               },
33
               "exclusivelyForCustomer
ExclusivelyForCustomer

If customer is specified, this customer owns the goods in stock/the product that is being manufactured

": {
34
                    "database
Database

Database of the object

": "{String}",
35
                    "customerId
CustomerId

Customer identifier

": "{Integer}",
36
                    "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
37
                    "customerLink
CustomerLink

Customer reference

": "{String}"
38
               },
39
               "assignmentRegisterLink
AssignmentRegisterLink

Assignment register reference

": "{String}"
40
          }
41
     ],
42
     "paging
Paging

Detailed paging information for this list.

": {
43
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
44
          "position
Position

Position of the first element in the list

": "{Integer}",
45
          "page
Page

Page index

": "{Integer}",
46
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
47
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
48
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
49
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
50
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
51
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
52
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
53
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
54
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
55
     }
56
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: